<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>ssl::stream</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="ssl__rfc2818_verification/rfc2818_verification.html"
          title="ssl::rfc2818_verification::rfc2818_verification">
    <link rel="next" href="ssl__stream/async_handshake.html" title="ssl::stream::async_handshake">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="ssl__rfc2818_verification/rfc2818_verification.html"><img src="../../prev.png"
                                                                                     alt="Prev"></a><a accesskey="u"
                                                                                                       href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="ssl__stream/async_handshake.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.ssl__stream"></a><a class="link" href="ssl__stream.html" title="ssl::stream">ssl::stream</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.ssl__stream"></a>
    </p>
    <p>
        Provides stream-oriented functionality using SSL.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <span class="identifier">Stream</span><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">stream</span> <span class="special">:</span>
  <span class="keyword">public</span> <span class="identifier">ssl</span><span class="special">::</span><span
                class="identifier">stream_base</span><span class="special">,</span>
  <span class="identifier">noncopyable</span>
</pre>
    <h5>
        <a name="asio.reference.ssl__stream.h0"></a>
        <span><a name="asio.reference.ssl__stream.types"></a></span><a class="link"
                                                                       href="ssl__stream.html#asio.reference.ssl__stream.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream__impl_struct.html" title="ssl::stream::impl_struct"><span
                                class="bold"><strong>impl_struct</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Structure for use with deprecated impl_type.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/executor_type.html" title="ssl::stream::executor_type"><span
                                class="bold"><strong>executor_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of the executor associated with the object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/handshake_type.html" title="ssl::stream::handshake_type"><span
                                class="bold"><strong>handshake_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Different handshake types.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/lowest_layer_type.html"
                           title="ssl::stream::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of the lowest layer.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/native_handle_type.html"
                           title="ssl::stream::native_handle_type"><span
                                class="bold"><strong>native_handle_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The native handle type of the SSL stream.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/next_layer_type.html"
                           title="ssl::stream::next_layer_type"><span
                                class="bold"><strong>next_layer_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of the next layer.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.ssl__stream.h1"></a>
        <span><a name="asio.reference.ssl__stream.member_functions"></a></span><a class="link"
                                                                                  href="ssl__stream.html#asio.reference.ssl__stream.member_functions">Member
        Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/async_handshake.html"
                           title="ssl::stream::async_handshake"><span
                                class="bold"><strong>async_handshake</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Start an asynchronous SSL handshake.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/async_read_some.html"
                           title="ssl::stream::async_read_some"><span
                                class="bold"><strong>async_read_some</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Start an asynchronous read.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/async_shutdown.html" title="ssl::stream::async_shutdown"><span
                                class="bold"><strong>async_shutdown</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Asynchronously shut down SSL on the stream.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/async_write_some.html"
                           title="ssl::stream::async_write_some"><span
                                class="bold"><strong>async_write_some</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Start an asynchronous write.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/get_executor.html" title="ssl::stream::get_executor"><span
                                class="bold"><strong>get_executor</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the executor associated with the object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/handshake.html" title="ssl::stream::handshake"><span
                                class="bold"><strong>handshake</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Perform SSL handshaking.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/lowest_layer.html" title="ssl::stream::lowest_layer"><span
                                class="bold"><strong>lowest_layer</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get a reference to the lowest layer.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/native_handle.html" title="ssl::stream::native_handle"><span
                                class="bold"><strong>native_handle</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the underlying implementation in the native type.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/next_layer.html" title="ssl::stream::next_layer"><span
                                class="bold"><strong>next_layer</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get a reference to the next layer.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/operator_eq_.html" title="ssl::stream::operator="><span
                                class="bold"><strong>operator=</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Move-assign a stream from another.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/read_some.html" title="ssl::stream::read_some"><span
                                class="bold"><strong>read_some</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Read some data from the stream.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/set_verify_callback.html"
                           title="ssl::stream::set_verify_callback"><span
                                class="bold"><strong>set_verify_callback</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Set the callback used to verify peer certificates.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/set_verify_depth.html"
                           title="ssl::stream::set_verify_depth"><span
                                class="bold"><strong>set_verify_depth</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Set the peer verification depth.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/set_verify_mode.html"
                           title="ssl::stream::set_verify_mode"><span
                                class="bold"><strong>set_verify_mode</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Set the peer verification mode.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/shutdown.html" title="ssl::stream::shutdown"><span
                                class="bold"><strong>shutdown</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Shut down SSL on the stream.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/stream.html" title="ssl::stream::stream"><span
                                class="bold"><strong>stream</strong></span></a>
                        <span class="silver">[constructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Construct a stream. <br> <span class="silver"> —</span><br> Construct a stream from an existing
                        native implementation. <br> <span class="silver"> —</span><br> Move-construct a stream from
                        another.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/write_some.html" title="ssl::stream::write_some"><span
                                class="bold"><strong>write_some</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Write some data to the stream.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="ssl__stream/_stream.html" title="ssl::stream::~stream"><span class="bold"><strong>~stream</strong></span></a>
                        <span class="silver">[destructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Destructor.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <p>
        The stream class template provides asynchronous and blocking stream-oriented
        functionality using SSL.
    </p>
    <h5>
        <a name="asio.reference.ssl__stream.h2"></a>
        <span><a name="asio.reference.ssl__stream.thread_safety"></a></span><a class="link"
                                                                               href="ssl__stream.html#asio.reference.ssl__stream.thread_safety">Thread
        Safety</a>
    </h5>
    <p>
        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
    </p>
    <p>
        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. The
        application
        must also ensure that all asynchronous operations are performed within the
        same implicit or explicit strand.
    </p>
    <h5>
        <a name="asio.reference.ssl__stream.h3"></a>
        <span><a name="asio.reference.ssl__stream.example"></a></span><a class="link"
                                                                         href="ssl__stream.html#asio.reference.ssl__stream.example">Example</a>
    </h5>
    <p>
        To use the SSL stream template with an <code class="computeroutput"><span class="identifier">ip</span><span
            class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span
            class="identifier">socket</span></code>, you would write:
    </p>
    <pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span
            class="identifier">io_context</span> <span class="identifier">my_context</span><span
            class="special">;</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">ssl</span><span
                class="special">::</span><span class="identifier">context</span> <span
                class="identifier">ctx</span><span class="special">(</span><span class="identifier">asio</span><span
                class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span
                class="identifier">context</span><span class="special">::</span><span
                class="identifier">sslv23</span><span class="special">);</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">ssl</span><span
                class="special">::</span><span class="identifier">stream</span><span class="special">&lt;</span><span
                class="identifier">asio</span><span class="special">:</span><span class="identifier">ip</span><span
                class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span
                class="identifier">socket</span><span class="special">&gt;</span> <span
                class="identifier">sock</span><span class="special">(</span><span
                class="identifier">my_context</span><span class="special">,</span> <span
                class="identifier">ctx</span><span class="special">);</span>
</pre>
    <h5>
        <a name="asio.reference.ssl__stream.h4"></a>
        <span><a name="asio.reference.ssl__stream.requirements"></a></span><a class="link"
                                                                              href="ssl__stream.html#asio.reference.ssl__stream.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/stream.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio/ssl.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="ssl__rfc2818_verification/rfc2818_verification.html"><img src="../../prev.png"
                                                                                     alt="Prev"></a><a accesskey="u"
                                                                                                       href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="ssl__stream/async_handshake.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
